Mention ready in the docs for connect
#287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes #280 There can be confusion when there are errors creating the channel because the only wait to catch them is to include an `await channel.ready` in the try block. Mention that `ready` can complete as an error in the case of connection failure.
brianquinlan
reviewed
Oct 6, 2023
CHANGELOG.md
Outdated
|
|
||
| - Update the examples to use `WebSocketChannel.ready` and clarify that | ||
| `WebSocketChannel.ready` should be awaited before sending data over the | ||
| `WebSocketChannel`. | ||
| - Mention `ready` in the docs for `conenct`. |
lib/src/channel.dart
Outdated
| /// not established synchronously. | ||
| /// The [ready] future will complete after the channel is connected. | ||
| /// If there are errors creating the connection the [ready] future will | ||
| /// complete as an error. |
There was a problem hiding this comment.
don't we normally say "with" an error? I'm not sure, feel free to ignore.
brianquinlan
approved these changes
Oct 6, 2023
mosuem
pushed a commit
to dart-lang/http
that referenced
this pull request
Dec 11, 2024
…el#287) Closes dart-lang/web_socket_channel#280 There can be confusion when there are errors creating the channel because the only wait to catch them is to include an `await channel.ready` in the try block. Mention that `ready` can complete as an error in the case of connection failure.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #280
Errors during connection can cause confusion because they escape a try
block unless there is an
await channel.ready. Mention thatreadycancomplete as an error in the case of connection failure.